accept attachment name or url to get addon config #20

ekozilforce · 2025-05-08T15:17:28Z

Description

This pr renames getConnection -> getAuthorization it to accept a url or attachment name to resolve addon config.

Some other small changes as per https://gus.lightning.force.com/lightning/r/ADM_Work__c/a07EE00002C13J3YAJ/view:

update the authorization requests to send a developer_name instead of org_name

Todo

Change auth request from POST to GET: GET /addons/${addon_uuid}/authorizations/${developer_name_or_id}
Handle response format change
Test e2e

ekozilforce · 2025-05-08T15:20:15Z

src/add-ons/heroku-applink.ts

 * @returns Org
 */
-export async function getConnection(name: string): Promise<Org> {
+export async function getAuthorization(name: string, attachmentNameOrUrl = "APPLINK"): Promise<Org> {


Should the param name become developer_name_or_id? It looks like the auth endpoint may accept either, considering the requested change:

From POST to GET: GET /addons/${addon_uuid}/authorizations/${developer_name_or_id}

ekozilforce · 2025-05-08T15:24:05Z

README.md

@@ -29,7 +29,7 @@ fastify.get('/accounts', async function (request, reply) {
        const applinkAddon = request.sdk.addons.applink;

        logger.info(`Getting org '${orgName}' connection from Heroku Applink add-on...`);
-        const anotherOrg = await applinkAddon.getConnection(orgName);
+        const anotherOrg = await applinkAddon.getAuthorization(orgName);


Might need to rethink the example a bit here given the change to use a developer name instead of org name.

Yeah, agree. Best to be consistent.

cwallsfdc

Looking good!

Plus GET per WI update.

cwallsfdc · 2025-05-08T15:47:14Z

README.md

@@ -29,7 +29,7 @@ fastify.get('/accounts', async function (request, reply) {
        const applinkAddon = request.sdk.addons.applink;

        logger.info(`Getting org '${orgName}' connection from Heroku Applink add-on...`);
-        const anotherOrg = await applinkAddon.getConnection(orgName);
+        const anotherOrg = await applinkAddon.getAuthorization(orgName);


Yeah, agree. Best to be consistent.

cwallsfdc · 2025-05-08T15:48:48Z

src/add-ons/heroku-applink.ts


 const HTTP_REQUEST = new HttpRequestUtil();

 /**
 * Get stored Salesforce or Data Cloud org user credentials for given name or alias.
 * @param name or alias
+ * @param attachmentNameOrUrl Either an attachment name (e.g. "APPLINK") or a full URL


e.g. "APPLINK" -> e.g. "HEROKU_APPLINK"? Or, since that's the default, e.g. "MYNAME", e.g. "IVORY"? Should we say it defaults to "HEROKU_APPLINK".

Yeah, this should be HEROKU_APPLINK since that's the default attachment iirc.

cwallsfdc · 2025-05-08T15:49:12Z

src/add-ons/heroku-applink.ts

-export async function getConnection(name: string): Promise<Org> {
+export async function getAuthorization(
+  name: string,
+  attachmentNameOrUrl = "APPLINK"


HEROKU_APPLINK?

cwallsfdc · 2025-05-08T15:50:41Z

src/utils/addon-config.ts

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.


2025. Favor: update date everywhere?

👍 I'll handle that in a separate pr to avoid noise.

cwallsfdc · 2025-05-08T15:52:29Z

src/add-ons/heroku-applink.ts

+export async function getAuthorization(
+  name: string,
+  attachmentNameOrUrl = "APPLINK"
+): Promise<Org> {
  if (!name) {
    throw Error(`Connection name not provided`);


Developer name.

cwallsfdc · 2025-05-08T15:53:12Z

src/add-ons/heroku-applink.ts

+import {
+  resolveAddonConfigByAttachment,
+  resolveAddonConfigByUrl,
+} from "~/utils/addon-config";

 const HTTP_REQUEST = new HttpRequestUtil();

 /**
 * Get stored Salesforce or Data Cloud org user credentials for given name or alias.


given developer name.

cwallsfdc · 2025-05-08T15:54:02Z

src/add-ons/heroku-applink.ts

+export async function getAuthorization(
+  name: string,
+  attachmentNameOrUrl = "APPLINK"
+): Promise<Org> {
  if (!name) {
    throw Error(`Connection name not provided`);


Developer name.

cwallsfdc · 2025-05-08T15:55:09Z

src/utils/addon-config.ts

+  // Look for corresponding token
+  const token = process.env[`${prefix}_TOKEN`];
+  if (!token) {
+    throw Error(`Heroku Applink config not found for API URL: ${url}`);


Token not found?

No strong feelings here right now. I can change to reference the missing token config var explicitly.

ekozilforce commented May 8, 2025

View reviewed changes

accept attachment name or url to get addon config

ce169a4

ekozilforce force-pushed the ekozil/add-attachment-or-url-scoped-authorizations branch from 7281237 to ce169a4 Compare May 8, 2025 15:29

cwallsfdc requested changes May 8, 2025

View reviewed changes

ekozilforce added 2 commits May 13, 2025 14:16

pr feedback

5296123

update authorization request shape

6ae41dc

ekozilforce force-pushed the ekozil/add-attachment-or-url-scoped-authorizations branch from cdb2ad6 to 6ae41dc Compare May 13, 2025 19:41

ekozilforce merged commit 6ae41dc into main May 14, 2025
9 of 10 checks passed

		@@ -0,0 +1,56 @@
		/*
		* Copyright (c) 2024, salesforce.com, inc.

accept attachment name or url to get addon config #20

accept attachment name or url to get addon config #20

Uh oh!

Conversation

ekozilforce commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Todo

Uh oh!

ekozilforce May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cwallsfdc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ekozilforce commented May 8, 2025 •

edited

Loading

ekozilforce May 8, 2025 •

edited

Loading